Onboard-MerchantLogos API

(0 reviews)

Use Cases

Using the Onboard-merchant Logos API will allow a merchant to generate a logo_id to be used in the shipping labels for use in the NZ Post parcel network for domestic shipping. Prior to using this API service, merchants will need to contact an account manager at NZ Post to set up NZ Post Account Number to send parcels across NZ Post network.

UseCase of the Onboard-MerchantLogos API

1) Gnerate a Logo_id

A merchant will request for a logo_id by calling Onboard-Merchant Logos API.

Example : NZPost logo

resources/Test_nzpost_logo-9de78c48-217b-40ad-b7f0-874b95f40155.PNG

Response after calling API with base64 format :

resources/logo_id_response-f42d7b5b-25cb-43bc-805f-f0ac1e5dfe2b.PNG

2) Generate Outbound/return Doemstic labels with your logos on the label by calling ParcelLabel V3 API

After generating logo_id, you can call our ParcelLabel V3 API by passing the logo_id for an outbound or return labels. The logo will then appear on the labels

resources/Label_logo-1004b28b-a31b-49b1-99ca-c2cde0fa76a6.PNG


Reviews